home *** CD-ROM | disk | FTP | other *** search
/ Amiga Developer CD v2.1 / Amiga Developer CD v2.1.iso / NDK / NDK_1.3 / Autodocs1.3 / LinkerLibs / debug.doc < prev    next >
Text File  |  1988-10-16  |  4KB  |  136 lines
  1. TABLE OF CONTENTS
  2.  
  3. debug.lib/KCmpStr
  4. debug.lib/KGetChar
  5. debug.lib/KGetNum
  6. debug.lib/KMayGetChar
  7. debug.lib/KPrintF
  8. debug.lib/KPutChar
  9. debug.lib/KPutStr
  10.  
  11.  
  12. debug.lib/KCmpStr                                             debug.lib/KCmpStr
  13.  
  14.    NAME
  15.     KCmpStr - compare two null terminated strings
  16.  
  17.    SYNOPSIS
  18.     mismatch = KCmpStr(string1, string2)
  19.     D0         A0        A1
  20.  
  21.    FUNCTION
  22.     string1 is compared to string2 using the ASCII coalating
  23.     sequence.  0 indicates the strings are identical.
  24.  
  25. debug.lib/KGetChar                                           debug.lib/KGetChar
  26.  
  27.    NAME
  28.     KGetChar - get a character from the console
  29.            (defaults to the serial port at 9600 baud)
  30.  
  31.    SYNOPSIS
  32.     char = KGetChar()
  33.     D0
  34.  
  35.    FUNCTION
  36.     busy wait until a character arrives from the console.
  37.     KGetChar is the assembly interface, _KGetChar and _kgetc
  38.     are the C interfaces.
  39.  
  40. debug.lib/KGetNum                                             debug.lib/KGetNum
  41.  
  42.    NAME
  43.     KGetNum - get a number from the console
  44.  
  45.    SYNOPSIS
  46.     number = KGetNum()
  47.     D0
  48.  
  49.    FUNCTION
  50.     get a signed decimal integer from the console.  This will busy
  51.     wait until the number arrives.
  52.  
  53.  
  54. debug.lib/KMayGetChar                                     debug.lib/KMayGetChar
  55.  
  56.    NAME
  57.     KMayGetChar - return a character if present, but don't wait
  58.               (defaults to the serial port at 9600 baud)
  59.  
  60.    SYNOPSIS
  61.     flagChar = KMayGetChar()
  62.     D0
  63.  
  64.    FUNCTION
  65.     return either a -1, saying that there is no character present, or
  66.     whatever character was waiting.  KMayGetChar is the assembly
  67.     interface,  _KMayGetChar is the C interface.
  68.  
  69. debug.lib/KPrintF                                             debug.lib/KPrintF
  70.  
  71.    NAME
  72.     KPrintF - print formatted data to the console
  73.               (defaults to the serial port at 9600 baud)
  74.  
  75.    SYNOPSIS
  76.     KPrintF("format string",values)
  77.              A0             A1
  78.  
  79.    FUNCTION
  80.     print a formatted C-type string to the console.  See the
  81.     exec RawDoFmt() call for the supported % formatting commands.
  82.  
  83.    INPUTS
  84.     "format string" - A C style string with % commands to indicate
  85.                       where paramters are to be inserted.
  86.     values - A pointer to an array of paramters, to be inserted into
  87.              specified places in the string.
  88.  
  89.     KPrintf is the assembly interface that wants the two pointers
  90.     in registers.  _KPrintF and _kprintf are the C interfaces that
  91.     expect the format string on the stack, and the paramters on
  92.     the stack above that.
  93.  
  94.    SEE ALSO
  95.     exec.library/RawDoFmt, any C compiler's "printf" call.
  96.  
  97. debug.lib/KPutChar                                           debug.lib/KPutChar
  98.  
  99.    NAME
  100.     KPutChar - put a character to the console
  101.            (defaults to the serial port at 9600 baud)
  102.  
  103.    SYNOPSIS
  104.     char = KPutChar(char)
  105.     D0           D0
  106.  
  107.    FUNCTION
  108.     put a character to the console.  This function will not return
  109.     until the character has been completely transmitted.
  110.  
  111.    INPUTS
  112.     KPutChar is the assembly interface, the character must be in D0.
  113.     _KPutchar and _kputc are the C interfaces, the character must be
  114.     a longword on the stack.
  115.  
  116.  
  117. debug.lib/KPutStr                                             debug.lib/KPutStr
  118.  
  119.    NAME
  120.     KPutStr - put a string to the console
  121.            (defaults to the serial port at 9600 baud)
  122.  
  123.    SYNOPSIS
  124.     KPutStr(string)
  125.             A0
  126.  
  127.    FUNCTION
  128.     put a null terminated string to the console.  This function will
  129.     not return until the string has been completely transmitted.
  130.  
  131.    INPUTS
  132.     KPutStr is the assembly interface, a string pointer must be in A0.
  133.     _KPutStr and _kputs are the C interfaces, the string pointer must
  134.     be on the stack.
  135.  
  136.